Rainbow Android SDK/com.ale.rainbowsdk/Routing

Routing

interface Routing

Types

Link copied to clipboard
object Companion
Link copied to clipboard
interface IGetRoutineListener

Interface to get a routine. Only for Cloud PBX.

Properties

Link copied to clipboard
abstract val cliOptions: List<CLIOptions>?

Get the list of all CLI Options available for the user. Only for Cloud PBX.

Link copied to clipboard
abstract var clirStatus: Boolean

Get/set the new CLIR status. On true, it overrides the CLI option defined and use an anonymous identity for external outgoing calls. Only for Cloud PBX.

Link copied to clipboard
abstract val isDefaultOverflowActivated: Boolean

Check if the user has a default overflow activated or not (a forward for BUSY or NO_ANSWER). This is configured at Company level. Only for Cloud PBX.

Link copied to clipboard
abstract val isMediaPillarRegistered: Boolean

Check if VoIP is up and running (the user will be able handle PBX calls through VoIP).

Link copied to clipboard
abstract val isMonolineIncomingMode: Boolean

Check if second incoming call should be presented to the user or not. Only for Cloud PBX.

Link copied to clipboard
abstract val isMultiDevicesUser: Boolean

Check if user has more than one device or not. Only for Cloud PBX.

Link copied to clipboard
abstract val isNomadicActivatedOnMediapillar: Boolean

Check if the current nomadic state will let the PBX join the current device running the application through VoIP. Always true for Cloud PBX.

Link copied to clipboard
abstract val isNomadicActivatedOnMyMobile: Boolean

Check if the current nomadic state will let the PBX join the current device running the application through VoIP or GSM. Always true for Cloud PBX.

Link copied to clipboard
abstract val isNomadicDeactivatedOnMyMobile: Boolean

Check if the current nomadic state will not let the PBX join the current device running the application Always false for Cloud PBX.

Functions

Link copied to clipboard
abstract fun activateNomadic(phoneNumber: String?)

Activate the nomadic on the specified number. Only for Hybrid PBX.

Link copied to clipboard
abstract fun activateRoutine(routineId: String, listener: RainbowListener<Unit, Unit>)

Activate a routine from its id. Only for Cloud PBX.

Link copied to clipboard
abstract fun areAllDevicesRinging(): Boolean

Check if all user devices are ringing for incoming calls. Only for Cloud PBX.

Link copied to clipboard
abstract fun cancelForward(forwardType: ForwardType)

Cancel automatic call forwarding depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

Link copied to clipboard
abstract fun cancelManagerForward(jid: String)

Cancel automatic call forwarding for Manager. Only for Hybrid PBX.

Link copied to clipboard
abstract fun createRoutine(name: String, listener: RainbowListener<Routine, Unit>)

Create a new routine with the given name.

Link copied to clipboard
abstract fun deactivateNomadic()

Deactivate the nomadic. Only for Hybrid PBX.

Link copied to clipboard
abstract fun deleteRoutine(routine: Routine, listener: RainbowListener<Unit, Unit>)

Delete a routine.

Link copied to clipboard
abstract fun forwardManagerToNumber(jid: String, number: String?)

Activate automatic call forwarding for Manager to the given number. Only for Hybrid PBX.

Link copied to clipboard
abstract fun forwardManagerToVoiceMail(jid: String)

Activate automatic call forwarding for Manager to the voicemail. Only for Hybrid PBX.

Link copied to clipboard
abstract fun forwardToNumber(number: String?, internal: Boolean, type: ForwardType)

Activate automatic call forwarding to the given number and depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

Link copied to clipboard
abstract fun forwardToVoiceMail(type: ForwardType)

Activate automatic call forwarding to the voicemail depending on the given ForwardType (BUSY or NO_ANSWER are only for Cloud PBX).

Link copied to clipboard
abstract fun forwardToWelcomeService(welcomeServiceId: String, type: ForwardType)

Activate automatic call forwarding to the given welcome service and depending on the given ForwardType. Only for Cloud PBX

Link copied to clipboard
abstract fun getActiveRoutine(): Routine?

Return the active routine, if there is one, null otherwise.

Link copied to clipboard
abstract fun getBusyForwardStatus(): ForwardStatus?

Get the current Forward status, when you are busy, allowing you to know the destination of your PBX calls. Only for Cloud PBX.

Link copied to clipboard
abstract fun getDeviceNumber(): String?

Get the device GSM phone number (SIM1) if any and if readable. Some carriers are not allowing the phone number read from SIM card.

Link copied to clipboard
abstract fun getForwardStatus(): ForwardStatus?

Get the current Forward status allowing you to know the destination of your PBX calls.

Link copied to clipboard
abstract fun getManagerForwardStatus(jid: String): ForwardStatus?

Get the current Manager Forward status allowing you to know the destination of his PBX calls.

Link copied to clipboard
abstract fun getNoAnswerForwardStatus(): ForwardStatus?

Get the current Forward status, when you are not answering, allowing you to know the destination of your PBX calls. Only for Cloud PBX.

Link copied to clipboard
abstract fun getNomadicNumber(withMediapillar: Boolean): String?

Get the nomadic number to use to activate nomadic.

Link copied to clipboard
abstract fun getNomadicStatus(): NomadicStatus?

Get the current Nomadic status allowing you to know the destination of your PBX calls. Always null for Cloud PBX.

Link copied to clipboard
abstract fun getOverflowForwardStatus(): ForwardStatus?

Get the current overflow forward status allowing you to know the destination of your PBX calls when you are disconnected.

Link copied to clipboard
abstract fun getRoutineById(routineId: String, listener: Routing.IGetRoutineListener)

Get a specific routine from its id. As the result may be asynchronous, it is returned in the listener. Only for Cloud PBX.

Link copied to clipboard
abstract fun getRoutinesList(): ArrayItemList<Routine>

Get the list of available routines. The returned object is an ArrayItemList so you can listen to its changes. Only for Cloud PBX.

Link copied to clipboard
abstract fun getSelectedCliOption(): CLIOptions?

Get the current selected CLI Options for the user. Only for Cloud PBX.

Link copied to clipboard
abstract fun hasMediaPillar(): Boolean

Check if the user has access to VoIP for PBX calls.

Link copied to clipboard
abstract fun hasTelephonyServices(): Boolean

Check if telephony services are up and running (the user will be able handle PBX calls).

Link copied to clipboard
abstract fun modifyRoutine(routine: Routine, listener: RainbowListener<Unit, Unit>)

Modify a routine. Only for Cloud PBX.

Link copied to clipboard
abstract fun registerCliChangeListener(listener: RoutingMgr.ICliChangeListener)

Register a listener on the CLI options change

Link copied to clipboard
abstract fun registerForwardStatusChangeListener(listener: RoutingMgr.IForwardStatusChangeListener)

Register a listener on the forward change

Link copied to clipboard
abstract fun registerNomadicStatusChangeListener(listener: RoutingMgr.INomadicStatusChangeListener)

Register a listener on the nomadic change

Link copied to clipboard
abstract fun registerRingingDevicesChangeListener(listener: RoutingMgr.IRingingDevicesChangeListener)

Register a listener on the ringing devices change. Only for Cloud PBX.

Link copied to clipboard
abstract fun registerTelephonyServicesChangeListener(listener: RoutingMgr.ITelephonyServicesChangeListener)

Register a listener on the telephony services change

Link copied to clipboard
abstract fun retrieveForwardStatus()

Manually refresh the forward status from server.

Link copied to clipboard
abstract fun retrieveNomadicStatus()

Manually refresh the nomadic status from server for Hybrid PBX only.

Link copied to clipboard
abstract fun selectCli(cliOption: CLIOptions)

Select the new CLI Options to use for identifying external outgoing calls. Only for Cloud PBX.

Link copied to clipboard
abstract fun unregisterCliChangeListener(listener: RoutingMgr.ICliChangeListener)

Unregister the listener on the CLI options change

Link copied to clipboard
abstract fun unregisterForwardStatusChangeListener(listener: RoutingMgr.IForwardStatusChangeListener)

Unregister the listener on the forward change

Link copied to clipboard
abstract fun unregisterNomadicStatusChangeListener(listener: RoutingMgr.INomadicStatusChangeListener)

Unregister the listener on the nomadic change

Link copied to clipboard
abstract fun unregisterRingingDevicesChangeListener(listener: RoutingMgr.IRingingDevicesChangeListener)

Unregister the listener on the ringing devices change. Only for Cloud PBX.

abstract fun unregisterTelephonyServicesChangeListener(listener: RoutingMgr.ITelephonyServicesChangeListener)

Unregister the listener on the telephony services change

Link copied to clipboard
abstract fun updateRingingDevices(webRTCOnly: Boolean)

Update ringing devices by activating only VoIP or not. Only for Cloud PBX.